Font Library: Font Collection backend #53816

matiasbenedetto · 2023-08-18T16:01:03Z

What?

Add extensibility capabilities to the Font Library.
Provides a way to provide collections of typographic fonts by code.

Why?

Standardize the way to add font collections to the font library.
Allows extenders code (plugins, for example) to register lists of fonts to let the user install the ones they want. Font foundries, for example, will be able to create a plugin to provide their fonts with just a few lines of code.

Example:

This is all the code required to create a plugin providing a font collection.

<?php
/*
Plugin Name: My Font Collection
Plugin URI: https://your-website.com/
Description: Add a font collection to your WordPress Font Library.
Version: 1.0
Author: Your Name
Author URI: https://your-website.com/
License: GPLv2 or later
Text Domain: my-font-collection
*/

$my_config = array (
    'id'             => 'my-font-collection',
    'name'           => 'My Font Collection',
    'description'    => 'Demo about how to a font collection to your WordPress Font Library.',
    'data_json_file' => path_join( __DIR__, 'my-font-collection-data.json' ),
);

if ( function_exists( 'wp_register_font_collection' ) ) {
    wp_register_font_collection ( $my_config );
}

?>

Download the plugin as zip ready to test:
my-font-collection.zip

How?

Implementation of a WP_Font_Collection class.
Implementation of the wp_register_font_collection filter.
Implementation of the /fonts/collections and fonts/collections/<id> endpoints.

To do

Add more ways to provide lists of fonts apart from the JSON file. (maybe for a future PR).
Add sanitization.
We would need this: WP_Theme_JSON sanitization is not working below certain level of theme.json #52798

Tracking issue:

Stage 1: #52698
Stage 2: #53307

github-actions · 2023-08-18T16:01:16Z

Warning: Type of PR label error

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

Type-related labels to choose from: [Type] Accessibility (a11y), [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core.
Labels found: [Feature] Extensibility, [Feature] Typography.

Read more about Type labels in Gutenberg.

github-actions · 2023-08-18T16:02:42Z

This pull request has changed or added PHP files. Please confirm whether these changes need to be synced to WordPress Core, and therefore featured in the next release of WordPress.

If so, it is recommended to create a new Trac ticket and submit a pull request to the WordPress Core Github repository soon after this pull request is merged.

If you're unsure, you can always ask for help in the #core-editor channel in WordPress Slack.

Thank you! ❤️

View changed files

❔ lib/experimental/fonts/font-library/class-wp-font-collection.php
❔ phpunit/tests/fonts/font-library/wpFontCollection/__construct.php
❔ phpunit/tests/fonts/font-library/wpFontCollection/getData.php
❔ phpunit/tests/fonts/font-library/wpFontLibrary/getFontCollection.php
❔ phpunit/tests/fonts/font-library/wpFontLibrary/getFontCollections.php
❔ phpunit/tests/fonts/font-library/wpFontLibrary/registerFontCollection.php
❔ phpunit/tests/fonts/font-library/wpRestFontLibraryController/base.php
❔ phpunit/tests/fonts/font-library/wpRestFontLibraryController/getFontCollection.php
❔ phpunit/tests/fonts/font-library/wpRestFontLibraryController/getFontCollections.php
❔ phpunit/tests/fonts/font-library/wpRestFontLibraryController/registerRoutes.php
❔ phpunit/tests/fonts/font-library/wpRestFontLibraryController/uninstallFonts.php
❔ lib/experimental/fonts/font-library/class-wp-font-library.php
❔ lib/experimental/fonts/font-library/class-wp-rest-font-library-controller.php
❔ lib/experimental/fonts/font-library/font-library.php
❔ lib/load.php
❔ phpunit/tests/fonts/font-library/wpFontFamily/base.php
❔ phpunit/tests/fonts/font-library/wpRestFontLibraryController/installFonts.php

github-actions · 2023-08-18T16:31:08Z

Flaky tests detected in 60997e9.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5979891576
📝 Reported issues:

[Flaky Test] should partially select with shift + click (@webkit) #53524 in /test/e2e/specs/editor/various/multi-block-selection.spec.js

lib/experimental/fonts/font-library/class-wp-font-library.php

spacedmonkey · 2023-08-19T23:49:03Z

If we must use static, then follow the pattern in wp_metadata_lazyloader that creates a instance to a static variable.

matiasbenedetto · 2023-08-21T19:11:16Z

If we must use static, then follow the pattern in wp_metadata_lazyloader that creates a instance to a static variable.

@spacedmonkey Thanks for the review!
Could you please add more context about why is that pattern preferred over static methods and properties?

lib/experimental/fonts/font-library/class-wp-font-library.php

Co-authored-by: Tonya Mork <[email protected]>

hellofromtonya · 2023-08-24T19:01:33Z

The source code LTGM and is ready 👍

Next: the tests need updating for the changes and then a code review. And then this PR is ready for merge.

Almost over the finish line with this PR.

matiasbenedetto · 2023-08-25T20:09:28Z

I updated the plugin demo code in the PR description and the plugin's zip file based on the latest PR changes.

matiasbenedetto · 2023-08-30T15:49:14Z

I created a follow-up of this PR to load data from URLs. It depends on this one: #53992

* Renamed files to remove `-test` suffix (no longer needed). * Removed extra empty line before closing the class. * Used Core's `assertWPError()`.

hellofromtonya

The source code LGTM 👍

The tests are good enough. I'll follow-up with a test improvement PR.

This PR is ready (assuming the CI jobs are happy).

matiasbenedetto · 2023-08-31T20:26:26Z

Thanks, @hellofromtonya, for your work here!

matiasbenedetto · 2023-08-31T20:26:32Z

I'm closing this PR because it's blocked by the changes requested by @spacedmonkey around the static class properties. I asked for more details about why we would need to avoid that pattern in this PR, and @hellofromtonya added some input about why the usage of the static property are intentional. Two weeks later, we didn't receive an answer, so I assume that the reasons presented are valid. This is blocking us from continuing the work on Font Library intended to be included in WordPress 6.4 release.

Because of that, I'm closing this PR and opening a new one. Of course, we are free to further discuss this topic on new issues, PRs, the make blog, or slack.

Adding Font Collection class

79d6af7

matiasbenedetto requested a review from spacedmonkey as a code owner August 18, 2023 16:01

matiasbenedetto mentioned this pull request Aug 18, 2023

[Tracking] Font Library. Stage 2: Fonts Library extensions #53307

Closed

18 tasks

matiasbenedetto added [Type] Technical Prototype Offers a technical exploration into an idea as an example of what's possible [Feature] Extensibility The ability to extend blocks or the editing experience [Feature] Typography Font and typography-related issues and PRs labels Aug 18, 2023

php formatting and linting

fd1c967

matiasbenedetto removed the [Type] Technical Prototype Offers a technical exploration into an idea as an example of what's possible label Aug 18, 2023

Adding tests for collections routes

0cfac6c

matiasbenedetto mentioned this pull request Aug 18, 2023

[Tracking] Font Library. Stage 1: Manage fonts and Local fonts upload #52698

Closed

16 tasks

matiasbenedetto changed the title ~~Font Library: Adding font collection backend~~ Font Library: Font Collection backend Aug 18, 2023

matiasbenedetto added 3 commits August 18, 2023 15:45

Adding tests for WP_Font_Collection constructor

6bb2f8b

adding tests for WP_Font_Collection get_data()

4a67d0b

adding tests for WP_Font_Library register_font_collection()

b26cb63

matiasbenedetto requested a review from hellofromtonya August 18, 2023 20:44

spacedmonkey requested changes Aug 19, 2023

View reviewed changes

lib/experimental/fonts/font-library/class-wp-font-library.php Outdated Show resolved Hide resolved

lib/experimental/fonts/font-library/class-wp-font-library.php Outdated Show resolved Hide resolved

lib/experimental/fonts/font-library/class-wp-font-library.php Outdated Show resolved Hide resolved

get font collection tests

0cfddb2

hellofromtonya reviewed Aug 21, 2023

View reviewed changes

lib/experimental/fonts/font-library/class-wp-font-library.php Outdated Show resolved Hide resolved

hellofromtonya reviewed Aug 21, 2023

View reviewed changes

lib/experimental/fonts/font-library/class-wp-font-library.php Outdated Show resolved Hide resolved

matiasbenedetto added 6 commits August 21, 2023 17:01

adding 'wp_' prefix to the 'register_font_collection' filter name

7ba6f61

fix callback name

454f9a5

making class property private

932064f

registering filter from font-library.php file

b184398

Merge branch 'trunk' into try/font-collections

6a2dfa0

removing superfluous comment

36ab188

matiasbenedetto and others added 2 commits August 24, 2023 15:56

array check

f8dc1a0

Co-authored-by: Tonya Mork <[email protected]>

Documents config array structure

4cb5c77

matiasbenedetto added 10 commits August 24, 2023 16:36

adding tests for /fonts/collections endpoint

4b7e5e3

adding /fonts/collections/<id> endpoint test

56607c9

format

c928ebe

format

aeb42cf

add test for missing collection

0a98de6

removing not needed variables

46f9fde

Add more tests and split the test for WP_REST_Font_Library_Controller

785262b

lint

de12fe7

try to create dir for tests in CI

dc560b8

Merge branch 'trunk' into try/font-collections

60997e9

This was referenced Aug 28, 2023

Font Library: load collection data from a URL #53992

Closed

[Font Library] Frontend: Load font collections in the frontend #54040

Closed

Font Library: load collection JSON data from a URL in the collection config #54067

Merged

Tests: Core prep

803a1d1

* Renamed files to remove `-test` suffix (no longer needed). * Removed extra empty line before closing the class. * Used Core's `assertWPError()`.

hellofromtonya approved these changes Aug 31, 2023

View reviewed changes

hellofromtonya enabled auto-merge (squash) August 31, 2023 18:31

Doh I changed the wrong assertion

d3935e3

hellofromtonya removed the request for review from spacedmonkey August 31, 2023 19:12

matiasbenedetto closed this Aug 31, 2023

auto-merge was automatically disabled August 31, 2023 20:26
Pull request was closed

matiasbenedetto mentioned this pull request Aug 31, 2023

Font Library: Font Collection backend #54098

Merged

hellofromtonya deleted the try/font-collections branch August 31, 2023 21:12

matiasbenedetto mentioned this pull request Sep 5, 2023

Font Library: include a system fonts collection by default. #54186

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Font Library: Font Collection backend #53816

Font Library: Font Collection backend #53816

matiasbenedetto commented Aug 18, 2023 •

edited

Loading

github-actions bot commented Aug 18, 2023 •

edited

Loading

github-actions bot commented Aug 18, 2023 •

edited

Loading

github-actions bot commented Aug 18, 2023 •

edited

Loading

spacedmonkey commented Aug 19, 2023

matiasbenedetto commented Aug 21, 2023

hellofromtonya commented Aug 24, 2023

matiasbenedetto commented Aug 25, 2023

matiasbenedetto commented Aug 30, 2023

hellofromtonya left a comment

matiasbenedetto commented Aug 31, 2023

matiasbenedetto commented Aug 31, 2023 •

edited

Loading

Font Library: Font Collection backend #53816

Font Library: Font Collection backend #53816

Conversation

matiasbenedetto commented Aug 18, 2023 • edited Loading

What?

Why?

Example:

How?

To do

Tracking issue:

github-actions bot commented Aug 18, 2023 • edited Loading

github-actions bot commented Aug 18, 2023 • edited Loading

github-actions bot commented Aug 18, 2023 • edited Loading

spacedmonkey commented Aug 19, 2023

matiasbenedetto commented Aug 21, 2023

hellofromtonya commented Aug 24, 2023

matiasbenedetto commented Aug 25, 2023

matiasbenedetto commented Aug 30, 2023

hellofromtonya left a comment

Choose a reason for hiding this comment

matiasbenedetto commented Aug 31, 2023

matiasbenedetto commented Aug 31, 2023 • edited Loading

matiasbenedetto commented Aug 18, 2023 •

edited

Loading

github-actions bot commented Aug 18, 2023 •

edited

Loading

github-actions bot commented Aug 18, 2023 •

edited

Loading

github-actions bot commented Aug 18, 2023 •

edited

Loading

matiasbenedetto commented Aug 31, 2023 •

edited

Loading